Skip to main content

currentDestination

Type​

property

Summary​

Go to a destination

Syntax​

get the currentDestination of <widget>
set the currentDestination of <widget> to { <destinationArray> | <destinationName> }

Description​

If set to a an array the page and location and zoom of the destination will be read from the array. This is the format that is sent as a parameter in the linkClicked message and is used by the documentBookmarks and documentOpenAction and documentNamedDestinations properties for goto type destinations:

  • "page": the page to go to
  • "mode": The value will be one of:"XYZ", "Fit", "FitH", "FitV", "FitR", "FitB", "FitBH", "FitBV"
  • "left": XYZ, FitV, FitBV & FitR modes
  • "top": XYZ, FitH, FitBH & FitR modes
  • "right": FitR mode
  • "bottom": FitR mode
  • "zoom": XYZ mode

If set to a string the string will be used to lookup a named destination.

When getting of current destination the the array description of the closest named destination given the current page and scroll will be returned. If there are no named destinations on the current page then the property will be empty.

Compatibility and Support​

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile